MailScheduler.h

Go to the documentation of this file.

#ifndef SCHEDULER_H_
#define SCHEDULER_H_
/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
#define TRUE (1u)
#endif
#ifndef CLEAR
#define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
#define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
#define BITS_IN_BYTE (8u)
#endif
#ifndef BITS_IN_32
#define BITS_IN_32  (32u)
#endif
#ifndef BITS_IN_16
#define BITS_IN_16  (16u)
#endif
#ifndef BYTES_IN_32
#define BYTES_IN_32  (4u)
#endif
#ifndef BYTES_IN_16
#define BYTES_IN_16  (2u)
#endif

#define SCHED_TRIGGER_TX_ISR        (0u)
#define SCHED_INBOX_DONE_SW_ISR_1  (0u)
#define SCHED_INBOX_DONE_SW_ISR_2  (1)
#define SCHED_INBOX_DONE_SW_ISR_3  (2u)
#define SCHED_INBOX_DONE_SW_ISR_4  (3u)
#define SCHED_RESCHED_1  (5u)
#define SCHED_RESCHED_2  (6u)
#define SCHED_RESCHED_3  (7u)

/* Masks for rescheduling */
#define RESCH_SRC_1 BIT0
#define RESCH_SRC_2 BIT1
#define RESCH_SRC_3 BIT2
/*** Function Macros ***/
#define SCHED_WHAT_IS_THE_TIME(XX)          XX = gu32SchedTickCount
#define SCHED_WHEN_WAS_THE_LAST_TX_DONE(XX) XX = gu32SchedTxDoneCount

#ifndef CLEAR_ISR_FLAG
#define CLEAR_ISR_FLAG(XX)       INTC.SSCIR[XX].B.CLR = TRUE
#endif
/*** Enums ***/

/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Constants ***/

/*** Globals ***/
extern vuint32_t gu32SchedTickCount;
extern vuint32_t gu32SchedTxDoneCount;
extern vuint8_t gu8RescheduleSource;
extern uint8_t gu8ReSchPITCh;
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u8fnSchedConfig()
 *
 */
uint8_t u8fnSchedConfig(uint32_t u32PITCnt, uint8_t u8PITCh, 
                        uint32_t u32ReSchCnt, uint8_t u8ReSchPITCh);
/*
 ******************************************************************************
 *
 * Function:          u8fnSchedEnable()
 *
 */
uint8_t u8fnSchedEnable(uint8_t u8Enable);
/*
 ******************************************************************************
 *
 * Function:          u8fnSchedDSPIMailTransfer()
 *
 */
uint8_t u8fnSchedDSPIMailTransfer(uint8_t u8DSPIInstance, uint8_t u8CS,
                                  uint8_t u8ContCS, uint8_t u8EndOfQueueFlag,
                                  uint16_t* pu16MsgSrc,
                                  uint16_t* pu16MsgResponse, uint16_t u16Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnSchedCompositeDSPIMailTransfer()
 *
 */
uint8_t u8fnSchedCompositeDSPIMailTransfer(const uint8_t u8DSPIInstance1,
                                           const uint8_t u8DSPIInstance2,
                                           const uint8_t u8CS,
                                           uint16_t* pu16MsgSrc1,
                                           uint16_t* pu16MsgSrc2,
                                           const uint16_t* pu16MsgResponse,
                                           uint16_t u16SizeAtOrigin);
/*
 ******************************************************************************
 *
 * Function:          u32fnSchedHasTimeElapsed()
 *
 */
uint32_t u32fnSchedHasTimeElapsed(uint32_t u32MyTickCount);
/*
 ******************************************************************************
 *
 * Function:          u32fnSchedIsTxDone()
 *
 */
uint32_t u32fnSchedIsTxDone(uint32_t u32MyTickCount);
/*
 ******************************************************************************
 *
 * Function:          vfnSchedIsr()
 *
 */
void vfnSchedIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnSchedInboxDoneIsr()
 *
 */
void vfnSchedInboxDoneIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnReschedulerIsr()
 *
 */
void vfnReschedulerIsr(void);

#endif /* SCHEDULER_H_ */